QnAMaker Client (stable:4.0)

2025/10/21 • 15 deleted methods

EndpointSettings_GetSettings (removed)
Description :  Gets endpoint settings for an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /endpointSettings
{}

⚐ Response (200)

{
activeLearning:
{
Description: Active Learning settings of the endpoint. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
EndpointSettings_UpdateSettings (removed)
Description :  Updates endpoint settings for an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /endpointSettings
{
endpointSettingsPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
activeLearning:
{
Description: Active Learning settings of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
EndpointKeys_GetKeys (removed)
Description :  Gets endpoint keys for an endpoint
Reference :  Link ¶

⚼ Request

GET:  /endpointkeys
{}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
Required: False ,
}
string ,
language:
{
Description: Language setting of runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
EndpointKeys_RefreshKeys (removed)
Description :  Re-generates an endpoint key.
Reference :  Link ¶

⚼ Request

PATCH:  /endpointkeys/{keyType}
{
keyType:
{
Description: Type of Key ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
Required: False ,
}
string ,
language:
{
Description: Language setting of runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Alterations_Get (removed)
Description :  Download alterations from runtime.
Reference :  Link ¶

⚼ Request

GET:  /alterations
{}

⚐ Response (200)

{
wordAlterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
{
alterations:
{
Description: Words that are synonymous with each other. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Alterations_Replace (removed)
Description :  Replace alterations data.
Reference :  Link ¶

⚼ Request

PUT:  /alterations
{
wordAlterations:
{
Description: New alterations data. ,
Required: True ,
}
{
wordAlterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
{
alterations:
{
Description: Words that are synonymous with each other. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_ListAll (removed)
Description :  Gets all knowledgebases for a user.
Reference :  Link ¶

⚼ Request

GET:  /knowledgebases
{}

⚐ Response (200)

{
knowledgebases:
{
Description: Collection of knowledgebase records. ,
Required: False ,
}
[
{
id:
{
Description: Unique id that identifies a knowledgebase. ,
Required: False ,
}
string ,
hostName:
{
Description: URL host name at which the knowledgebase is hosted. ,
Required: False ,
}
string ,
lastAccessedTimestamp:
{
Description: Time stamp at which the knowledgebase was last accessed (UTC). ,
Required: False ,
}
string ,
lastChangedTimestamp:
{
Description: Time stamp at which the knowledgebase was last modified (UTC). ,
Required: False ,
}
string ,
lastPublishedTimestamp:
{
Description: Time stamp at which the knowledgebase was last published (UTC). ,
Required: False ,
}
string ,
name:
{
Description: Friendly name of the knowledgebase. ,
Required: False ,
}
string ,
userId:
{
Description: User who created / owns the knowledgebase. ,
Required: False ,
}
string ,
urls:
{
Description: URL sources from which Q-A were extracted and added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
sources:
{
Description: Custom sources from which Q-A were extracted or explicitly added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Operations_GetDetails (removed)
Description :  Gets details of a specific long running operation.
Reference :  Link ¶

⚼ Request

GET:  /operations/{operationId}
{
operationId:
{
Description: Operation id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retryafter:
{
Description: Indicates how long the client should wait before sending a follow up request. The header will be present only if the operation is running or has not started yet. ,
}
integer ,
}
,
$schema:
{
Description: Record to track long running operation. ,
}
{
operationState:
{
Description: Operation state. ,
Enum:
{
Failed: No description available. ,
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Timestamp when the operation was created. ,
Required: False ,
}
string ,
lastActionTimestamp:
{
Description: Timestamp when the current state was entered. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Relative URI to the target resource location for completed resources. ,
Required: False ,
}
string ,
userId:
{
Description: User Id ,
Required: False ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: False ,
}
string ,
errorResponse:
{
Description: Error details in case of failures. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_GetDetails (removed)
Description :  Gets details of a specific knowledgebase.
Reference :  Link ¶

⚼ Request

GET:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique id that identifies a knowledgebase. ,
Required: False ,
}
string ,
hostName:
{
Description: URL host name at which the knowledgebase is hosted. ,
Required: False ,
}
string ,
lastAccessedTimestamp:
{
Description: Time stamp at which the knowledgebase was last accessed (UTC). ,
Required: False ,
}
string ,
lastChangedTimestamp:
{
Description: Time stamp at which the knowledgebase was last modified (UTC). ,
Required: False ,
}
string ,
lastPublishedTimestamp:
{
Description: Time stamp at which the knowledgebase was last published (UTC). ,
Required: False ,
}
string ,
name:
{
Description: Friendly name of the knowledgebase. ,
Required: False ,
}
string ,
userId:
{
Description: User who created / owns the knowledgebase. ,
Required: False ,
}
string ,
urls:
{
Description: URL sources from which Q-A were extracted and added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
sources:
{
Description: Custom sources from which Q-A were extracted or explicitly added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Delete (removed)
Description :  Deletes the knowledgebase and all its data.
Reference :  Link ¶

⚼ Request

DELETE:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Publish (removed)
Description :  Publishes all changes in test index of a knowledgebase to its prod index.
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Replace (removed)
Description :  Replace knowledgebase contents.
Reference :  Link ¶

⚼ Request

PUT:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
replaceKb:
{
Description: An instance of ReplaceKbDTO which contains list of qnas to be uploaded ,
Required: True ,
}
{
qnAList:
{
Description: List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted. ,
Required: True ,
}
[
{
id:
{
Description: Unique id for the Q-A. ,
Format: int32 ,
Required: False ,
}
integer ,
answer:
{
Description: Answer text ,
Required: True ,
}
string ,
source:
{
Description: Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: True ,
}
[
string ,
]
,
metadata:
{
Description: List of metadata associated with the answer. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context of a QnA ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Update (removed)
Description :  Asynchronous operation to modify a knowledgebase.
Reference :  Link ¶

⚼ Request

PATCH:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
updateKb:
{
Description: Post body of the request. ,
Required: True ,
}
{
add:
{
Description: An instance of CreateKbInputDTO for add operation ,
Required: False ,
}
string ,
delete:
{
Description: An instance of DeleteKbContentsDTO for delete Operation ,
Required: False ,
}
string ,
update:
{
Description: An instance of UpdateKbContentsDTO for Update Operation ,
Required: False ,
}
string ,
enableHierarchicalExtraction:
{
Description: Enable hierarchical extraction of Q-A from files and urls. The value set during KB creation will be used if this field is not present. ,
Required: False ,
}
boolean ,
defaultAnswerUsedForExtraction:
{
Description: Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Relative URI to the target location of the asynchronous operation. Client should poll this resource to get status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Record to track long running operation. ,
}
{
operationState:
{
Description: Operation state. ,
Enum:
{
Failed: No description available. ,
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Timestamp when the operation was created. ,
Required: False ,
}
string ,
lastActionTimestamp:
{
Description: Timestamp when the current state was entered. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Relative URI to the target resource location for completed resources. ,
Required: False ,
}
string ,
userId:
{
Description: User Id ,
Required: False ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: False ,
}
string ,
errorResponse:
{
Description: Error details in case of failures. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Create (removed)
Description :  Asynchronous operation to create a new knowledgebase.
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/create
{
createKbPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
name:
{
Description: Friendly name for the knowledgebase. ,
Required: True ,
}
string ,
qnaList:
{
Description: List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted. ,
Required: False ,
}
[
{
id:
{
Description: Unique id for the Q-A. ,
Format: int32 ,
Required: False ,
}
integer ,
answer:
{
Description: Answer text ,
Required: True ,
}
string ,
source:
{
Description: Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: True ,
}
[
string ,
]
,
metadata:
{
Description: List of metadata associated with the answer. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context of a QnA ,
Required: False ,
}
string ,
}
,
]
,
urls:
{
Description: List of URLs to be used for extracting Q-A. ,
Required: False ,
}
[
string ,
]
,
files:
{
Description: List of files from which to Extract Q-A. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. Supported file types are ".tsv", ".pdf", ".txt", ".docx", ".xlsx". ,
Required: True ,
}
string ,
fileUri:
{
Description: Public URI of the file. ,
Required: True ,
}
string ,
}
,
]
,
enableHierarchicalExtraction:
{
Description: Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present. ,
Required: False ,
}
boolean ,
defaultAnswerUsedForExtraction:
{
Description: Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True. ,
Required: False ,
}
string ,
language:
{
Description: Language of the knowledgebase. Please find the list of supported languages here. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operationState:
{
Description: Operation state. ,
Enum:
{
Failed: No description available. ,
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Timestamp when the operation was created. ,
Required: False ,
}
string ,
lastActionTimestamp:
{
Description: Timestamp when the current state was entered. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Relative URI to the target resource location for completed resources. ,
Required: False ,
}
string ,
userId:
{
Description: User Id ,
Required: False ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: False ,
}
string ,
errorResponse:
{
Description: Error details in case of failures. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Download (removed)
Description :  Download the knowledgebase.
Reference :  Link ¶

⚼ Request

GET:  /knowledgebases/{kbId}/{environment}/qna
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
environment:
{
Description: Specifies whether environment is Test or Prod. ,
Required: True ,
}
string ,
source:
{
Description: The source property filter to apply. Sample value: Editorial, smartLight%20FAQ.tsv . ,
Required: False ,
}
string ,
changedSince:
{
Description: changedSince property is used to return all QnAs created or updated after a specific time duration. The user can filter QnAs by seconds (s), minutes (m), hours (h) and days (d). The user may use any integral value along with the suffix for time. For instance, the value of 5m returns all QnA pairs updated or created in the last 5 minutes. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
qnaDocuments:
{
Description: List of answers. ,
Required: False ,
}
[
{
id:
{
Description: Unique id for the Q-A. ,
Format: int32 ,
Required: False ,
}
integer ,
answer:
{
Description: Answer text ,
Required: True ,
}
string ,
source:
{
Description: Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: True ,
}
[
string ,
]
,
metadata:
{
Description: List of metadata associated with the answer. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context of a QnA ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}